refactor(dfn-index): remove no-op toc subscription; improve comment#5216
Open
marcoscaceres wants to merge 5 commits intomainfrom
Open
refactor(dfn-index): remove no-op toc subscription; improve comment#5216marcoscaceres wants to merge 5 commits intomainfrom
marcoscaceres wants to merge 5 commits intomainfrom
Conversation
When #index is absent, dfn-index was subscribing to the "toc" event with an empty callback. The EventTarget-based pubsub doesn't require listeners, so this subscription had no effect. Remove it. Also rewrite the XXX comment on the real "toc" subscription to explain the ordering pattern more clearly.
Contributor
There was a problem hiding this comment.
Pull request overview
Removes an unnecessary no-op "toc" subscription in core/dfn-index and clarifies the rationale for subscribing to the real "toc" event used to append section numbers once core/structure has run.
Changes:
- Drop the dead
sub("toc", () => {}, { once: true })from the#index-missing early return path. - Rewrite the
"toc"subscription comment to explain the ordering dependency withcore/structure.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
|
Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
Contributor
|
Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
Contributor
Author
|
@copilot Can you confirm all your feedback has been addressed? Can you fix anything that was not addressed? |
Contributor
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
sub("toc", () => {}, { once: true })from the early-return path ofdfn-index.run(). TheEventTarget-based pubsub doesn't require listeners, so this subscription had no observable effect.XXXcomment on the real"toc"subscription (used to runappendSectionNumbersaftercore/structureassigns section numbers) to explain the ordering pattern clearly.Test plan
pnpm start --browser ChromeHeadless --grep="Core - Dfn Index"